GetRequestResult
Overview
The GetRequestResult operation is used to request status information about a previously submitted request based on a known request identifier (RequestID). This is typically called in concert with the Generate, PostProcess, or SelectAndGenerate operations. Where these operations are used to request document rendering and the GetRequestResult is used to request the documents be returned.
The operation returns document packets along with status and detailed information about the packets associated with the RequestID.
| Operation | GetRequestResult |
|---|---|
| Style | document |
| Operation Type | Request-response. The endpoint receives a message, and sends a correlated message. |
| SOAP Action | https://labw6408hvm113/DocGenServices/Services/Import/DocumentService/GetRequestResult |
| Input | GetRequestResult_InputMessage (soap:body, use = literal) parameterstype GetRequestResultIn |
| Output | GetRequestResult_OutputMessage (soap:body, use = literal) parameters type GetRequestResultOut |
Request Message
The operation input is GetRequestResultIn. The request (GetRequestResultIn) requires a request identifier (RequestID) and account identifier (AccountID) as a parameter on the input.
| Parameter | Type | Constraints | Description |
|---|---|---|---|
| request | GetRequestResultIn | Required | The input message for the GetRequestResult object used to define the request. |
Example Request Message
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:doc="http://www.wolterskluwerfs.com/2012/12/DocGenServices" xmlns:data="http://www.wolterskluwerfs.com/2012/12/DocGenServices/data">
<soap:Header/>
<soap:Body>
<doc:GetRequestResult>
<doc:request>
<data:RequestID>?</data:RequestID>
<data:AccountId>?</data:AccountId>
</doc:request>
</doc:GetRequestResult>
</soap:Body>
</soap:Envelope> Response Element
The operation output is GetRequestResultResponse. The response (GetRequestResultResult) includes a GetRequestResultOut object containing the status of the requested transaction.
| Element | Type | Description |
|---|---|---|
| GetRequestResultResult | GetRequestResultOut | The results object for the GetRequestResult operation. |